API Documentation
Projects -> Api Key
Connections
Data -> Catalogs
Data -> Internal Tables
Data -> Queries
Data -> Semantic Catalogs
Data -> Cache
Embedded Peaka Api
Supported Drivers
Data -> Metadata
- PUTUpdate Metadata
- PUTUpdate Relation From Metadata
- DELDelete Relation From Metadata
- PUTGenerate categorical values from the the column.
- POSTGenerate semantics for the table
- POSTAdd Relation To Metadata
- GETList of golden sqls for the project.
- POSTCreate golden sql for the project
- GETGet Project Metadata
- GETGet Project Catalog Metadata Relations
- GETGenerate sample ai questions for the project
- DELDelete golden sql from the project.
Update Metadata
PUT
/
metadata
/
{projectId}
/
{catalogId}
/
{schemaName}
/
{tableName}
curl --request PUT \
--url https://partner.peaka.studio/api/v1/metadata/{projectId}/{catalogId}/{schemaName}/{tableName} \
--header 'Content-Type: application/json' \
--data '{
"tableDescription": "<string>",
"columns": [
{
"columnName": "<string>",
"columnDescription": "<string>",
"dataType": "<string>",
"order": 123,
"isNotNull": true,
"isSystem": true,
"isUnique": true,
"isPrimary": true,
"isCategorical": true,
"categoricalValues": [
"<string>"
],
"lineage": [
{
"tables": [
"<string>"
],
"column": "<string>",
"expression": "<string>"
}
]
}
],
"useWithAI": true
}'
{}
Path Parameters
Body
application/json
Response
200 - */*
OK
curl --request PUT \
--url https://partner.peaka.studio/api/v1/metadata/{projectId}/{catalogId}/{schemaName}/{tableName} \
--header 'Content-Type: application/json' \
--data '{
"tableDescription": "<string>",
"columns": [
{
"columnName": "<string>",
"columnDescription": "<string>",
"dataType": "<string>",
"order": 123,
"isNotNull": true,
"isSystem": true,
"isUnique": true,
"isPrimary": true,
"isCategorical": true,
"categoricalValues": [
"<string>"
],
"lineage": [
{
"tables": [
"<string>"
],
"column": "<string>",
"expression": "<string>"
}
]
}
],
"useWithAI": true
}'
{}